Shipments | Equinix Product Documentation

Schedule inbound or outbound shipment

Request

This method schedules an inbound or outbound shipment for a user with shipments ordering permission.

Security

BearerAuth

Bodyapplication/json

typestringrequired

Type of shipment to be scheduled.

Enum:"INBOUND""OUTBOUND"

Example:"INBOUND"

requestedDateTimestring, (date-time)required

Date and time of shipment schedule in UTC timezone in ISO 8601 format.

Example:"2020-05-22T19:23:51.000Z"

cageIdstringrequired

ID of cage where shipment is to be delivered to or retrieve from.

Example:"DC2:01:001030"

detailsInboundShipments_create (object) or OutboundShipments_create (object)required

One of:

accountNumberstring

Customer account number. This is required if cage is shared.

Example:224552

descriptionstring, [ 10 .. 4000 ] characters

Any additional information that the technician may need to complete your request

Example:"Package is heavy, please operate with caution"

customerReferenceIdstring, [ 1 .. 40 ] characters

Customer Reference Number / External Reference Number

Example:"048837d6-4cd8-401f-ba41-a4ac015c3f3e"

purchaseOrderobject(purchaseOrder)

Purchase order required only when the Account PO Bareing

attachmentsArray of objects, <= 5 items(Attachment)

Additional attachments that is required to facilitate scheduled shipments such as instruction manual or photos. To learn about including attachments in your request, see POST Attachment API.

contactsArray of any

The ordering user is the default Technical and Notification contacts. If you would like to provide a different Technical contact and/or additional Notification contacts, provide the Techical contact and Notificition contact(s) details. There can only be 1 Technical contact (registered user or not), but there can be more than 1 Notification contacts (registered users).

Payload

{
  "customerReferenceId": "Customer Reference information free text",
  "description": "Please provide any additonal details the technician may need to complete your request.",
  "details": {
    "carrier": "DHL",
    "carrierTrackingNumbers": [ … ],
    "numberOfBoxes": 1
  },
  "attachments": [
    { … }
  ],
  "contacts": [
    { … },
    { … }
  ]
}

Responses

Created

Headers

Locationstring

Location on newly shipment request

Example:"/orders/1-23232322"

Response

No content